Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

first draft of new doc #233

Merged
merged 11 commits into from
Feb 20, 2024
Merged

first draft of new doc #233

merged 11 commits into from
Feb 20, 2024

Conversation

gheyselinck
Copy link
Contributor

What type of change is this?

  • Bug fix in a backwards-compatible manner.
  • New feature in a backwards-compatible manner.
  • Breaking change: bug fix or new feature that involve incompatible API changes.
  • Other (e.g. doc update, configuration, etc)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
  • I ran all tests on my computer and it's all green (i.e. invoke test).
  • I ran lint on my computer and there are no errors (i.e. invoke lint).
  • I added new functions/classes and made them available on a second-level import, e.g. compas_timber.datastructures.Beam.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if appropriate)

@gheyselinck gheyselinck added the no changelog No changes to CHANGELOG.md required in this PR label Feb 16, 2024
@chenkasirer
Copy link
Contributor

Restructured text can be quite particular on the syntax, I'm getting a bunch of errors when running invoke docs below. Could you please have a look at these and try to sort it out? these often result in unintended layout etc.

C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\beam.rst:12: WARNING: Explicit markup ends without a blank line; unexpected unindent.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\beam.rst:13: WARNING: Line block ends without a blank line.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\beam.rst:39: WARNING: Explicit markup ends without a blank line; unexpected unindent.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\beam.rst:40: WARNING: Line block ends without a blank line.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\features.rst:9: WARNING: Explicit markup ends without a blank line; unexpected unindent.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\features.rst:10: WARNING: Line block ends without a blank line.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\features.rst:14: WARNING: Bullet list ends without a blank line; unexpected unindent.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\features.rst:15: WARNING: Line block ends without a blank line.
C:\Users\ckasirer\repos\comlooking for now-outdated files... none found
pickling environment... pas_timber\docs\tutorials\grasshopper\features.rst:20: WARNING: Bullet list ends without a blank line; unexpected unindent.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\features.rst:21: WARNING: Line block ends without a blank line.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\features.rst:25: WARNING: Bullet list ends without a blank line; unexpected unindent.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\features.rst:26: WARNING: Line block ends without a blank line.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\joints.rst:24: WARNING: Title underline too short.

Joints for *L* Topologies
^^^^^^
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\joints.rst:118: WARNING: Title underline too short.

Joints for *T* Topologies
^^^^^^
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\joints.rst:118: WARNING: Title underline too short.

Joints for *T* Topologies
^^^^^^
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\joints.rst:166: WARNING: Title underline too short.

Joints for *X* Topologies
^^^^^^^
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\joints.rst:166: WARNING: Title underline too short.

Joints for *X* Topologies
^^^^^^^
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\rules.rst:1: WARNING: Title overline too short.

********
Joint Rules
********
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\rules.rst:7: WARNING: Explicit markup ends without a blank line; unexpected unindent.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\rules.rst:8: WARNING: Line block ends without a blank line.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\rules.rst:17: WARNING: Enumerated list ends without a blank line; unexpected unindent.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\rules.rst:18: WARNING: Line block ends without a blank line.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\rules.rst:25: WARNING: Enumerated list ends without a blank line; unexpected unindent.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\rules.rst:26: WARNING: Line block ends without a blank line.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\rules.rst:33: WARNING: Enumerated list ends without a blank line; unexpected unindent.
C:\Users\ckasirer\repos\compas_timber\docs\tutorials\grasshopper\rules.rst:34: WARNING: Line block ends without a blank line.

Copy link
Contributor

@chenkasirer chenkasirer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@gheyselinck gheyselinck merged commit cd32c66 into main Feb 20, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog No changes to CHANGELOG.md required in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants